<HTML><HEAD><TITLE>get_options(+OptionList, -OptionStruct)</TITLE>
</HEAD><BODY>[ <A HREF="index.html">library(module_options)</A> | <A HREF="../../index.html">Reference Manual</A> | <A HREF="../../fullindex.html">Alphabetic Index</A> ]
<H1>get_options(+OptionList, -OptionStruct)</H1>
Create a structure OptionStruct from OptionList and the context module's default settings
<DL>
<DT><EM>OptionList</EM></DT>
<DD>List of Name:Value pairs
</DD>
<DT><EM>OptionStruct</EM></DT>
<DD>Variable, will be bound to a structure
</DD>
</DL>
<H2>Description</H2>
<P>
    The exact behaviour of this predicate depends on the module from where
    it is invoked: It returns a structure OptionStruct, whose skeleton and
    default field values are defined by the predicate default_options/1 in
    the context module. Moreover, OptionList is analysed, and any option
    values specified there will show up in the corresponding fields of the
    returned structure OptionStruct, instead of the default values defined
    by default_options/1.
</P><P>
    The option names in OptionList must be valid according to the predicate
    valid_option_field/2 in the context module, and the corresponding values
    must be valid according to valid_option_value/2.
</P>
    
<H3>Modules</H3>
This predicate is sensitive to its module context (tool predicate, see @/2).
<H3>Fail Conditions</H3>
OptionList contains illegal names or values
<H2>See Also</H2>
<A HREF="../../lib/module_options/index.html">library(module_options)</A>, <A HREF="../../lib/module_options/set_default_option-2.html">set_default_option / 2</A>, <A HREF="../../lib/module_options/print_default_options-1.html">print_default_options / 1</A>
</BODY></HTML>
